﻿#region License, Terms and Conditions
//
// Copyright (c) 2008, aspZone.com
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the <organization> nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY aspZone.com ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author(s):
//  John Rudolf Lewis (http://aspZone.com)
//
#endregion

namespace AspZone.Commerce.Model
{
    using System.Collections.Generic;

    /// <summary>
    /// Represents a Product for sale in the store
    /// </summary>
    public class Product
    {
        public Product()
        {
            this.Images = new List<Image>();
            this.Categories = new List<Category>();
            this.Properties = new List<ProductProperty>();
        }

        /// <summary>
        /// Gets or sets the primary unique identifier for the Product.
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// Gets or sets the unique name of the Product.
        /// </summary>
        public string Name { get; set; }      

        /// <summary>
        /// Gets or sets the short description of the Product.
        /// </summary>
        /// <remarks>
        /// Used as a one line very short description of the Product, such as listing of 
        /// products in the cart, category listings, etc. No Rich HTML will be allowed here.
        /// </remarks>
        public string ShortDescription { get; set; }

        /// <summary>
        /// Gets or sets the long description of the Product.
        /// </summary>
        /// <remarks>
        /// To be displayed in a product detail view. Rich HTML content allowed.
        /// </remarks>
        public string LongDescription { get; set; }

        /// <summary>
        /// Gets or sets the name of the Product for use in &lt;Title&gt; tags.
        /// </summary>
        public string SEOTitle { get; set; }

        /// <summary>
        /// Gets or sets the name of the product for use in SEO url's
        /// </summary>
        public string SEOName { get; set; }

        /// <summary>
        /// Gets or sets the keywords for the Product.
        /// </summary>
        /// <remarks>
        /// Comma delimited list of Keywords to be used in the meta tags of a product detail view.
        /// </remarks>
        public string SEOKeywords { get; set; }

        /// <summary>
        /// Gets or sets the base price of the Product.
        /// </summary>
        public decimal Price { get; set; }

        /// <summary>
        /// Gets or sets the discount percent off the base price of the Product.
        /// </summary>
        public decimal DiscountPercent { get; set; }

        /// <summary>
        /// Gets or sets the handling charge that gets added to the total shipping and handling for an order.
        /// </summary>
        public decimal HandlingCharge { get; set; }

        /// <summary>
        /// Gets or sets the weight (in ounces) of the Product.
        /// </summary>
        public decimal Weight { get; set; }

        /// <summary>
        /// Gets or sets the number of units of this Product that are currently in stock.
        /// </summary>
        public int QuantityAvailable { get; set; }

        /// <summary>
        /// Gets or sets the list of <see cref="ProductImage"/> for this Product.
        /// </summary>
        public IList<Image> Images { get; set; }

        /// <summary>
        /// Gets or sets the list of Categories for this product.
        /// </summary>
        public IList<Category> Categories { get; set; }

        /// <summary>
        /// Gets or sets the list of <see cref="ProductProperty"/> for this Product.
        /// </summary>
        public IList<ProductProperty> Properties { get; set; }

        /// <summary>
        /// Determines wheter this <see cref="Product"/> and a specified <see cref="Product"/> are the same entity.
        /// </summary>
        /// <param name="product">the <see cref="Product"/> with which to compare with this <see cref="Product"/>.</param>
        /// <returns>true if the two products are the same entity.</returns>
        public bool Equals(Product product)
        {
            return product.Id == this.Id;
        }

        /// <summary>
        /// Returns a string representation of this Product,
        /// </summary>
        /// <returns>a string value that represents this Product.</returns>
        public override string ToString()
        {
            return this.Name;
        }

        /// <summary>
        /// Returns the hashcode of this instance.
        /// </summary>
        /// <returns>the hashcode of this instance.</returns>
        public override int GetHashCode()
        {
            return this.Id.GetHashCode();
        }
    }
}
